Skip to content

Scorm Package

Scorm packages are containers for a Sharable Content Object Reference Model that can be integrated with Schoology.

NOTE

Scorm packages exist in sections.

Fields

FieldNameDescriptionType
titleTitleThe scorm package title.string
urlLaunch UrlThe URL to launch the scorm package.string
num_attemptsNumber of AttemptsThe total number of attempts on a scorm package in the course section.integer
scorm_grading_enabledScorm Grading EnabledWhether or not grading for the Scorm Package is enabled. 0 or 1.integer
sco_grading_enabledSco Grading EnabledWhether or not grading for one or more Sco is enabled. 0 or 1.integer
grade_timing_typeGrade Timing TypeTiming type for the scorm/sco grade items: 1 = Scorm Completion, 2 = Sco Completion First, 3 = Sco Completion Last.integer
grade_timing_optionGrade Timing OptionTiming options for the scorm grade item (excl. extra credit): 1 = Score, 2 = Completion, 3 = Satisfaction.integer
availableAvailableThe availability status of the scorm package. 0 or 1.integer
completedCompletedWhether or not the scorm package has been completed. 0 or 1.integer
completion_statusCompletion StatusThe completion status of the scorm package.string
count_in_gradeCount in GradeUsed for pre-assessments or practice work allowing parents/students to see progress while knowing the score is not impacting a student's calculated grade. Applies only to Scorm packages enabled for grading. Default: 1.integer

GET sections/{section id}/packages

View a list of SCORM packages in a course section

Return A list of scorm packages

json
{
  "package": [
    {
      "id": 2581911,
      "title": "statistics_pack_5",
      "num_attempts": 0,
      "scorm_grading_enabled": 0,
      "sco_grading_enabled": 1,
      "grade_timing_type": 0,
      "grade_timing_option": 0,
      "url": "http:\/\/schoology.com\/course\/625104\/materials\/package\/2581911\/launch",
      "available": 1,
      "completed": 0,
      "completion_status": "",
      "count_in_grade": 1
    },
    {
      "id": 2582016,
      "title": "geometry_pack_5",
      "num_attempts": 0,
      "scorm_grading_enabled": 0,
      "sco_grading_enabled": 0,
      "grade_timing_type": 0,
      "grade_timing_option": 0,
      "url": "http:\/\/schoology.com\/course\/625104\/materials\/package\/2582016\/launch",
      "available": 1,
      "completed": 0,
      "completion_status": "",
      "count_in_grade": 1
    }
  ],
  "total": 2,
  "links": {
    "self": "http:\/\/schoology.com\/v1\/sections\/625104\/packages?start=0&limit=20"
  }
}
xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<package>
		<id>2581911</id>
		<title>statistics_pack_5</title>
		<num_attempts>0</num_attempts>
		<scorm_grading_enabled>0</scorm_grading_enabled>
		<sco_grading_enabled>1</sco_grading_enabled>
		<grade_timing_type>0</grade_timing_type>
		<grade_timing_option>0</grade_timing_option>
		<url>http://schoology.com/course/625104/materials/package/2581911/launch</url>
		<available>1</available>
		<completed>0</completed>
		<completion_status />
		<count_in_grade>1</count_in_grade>
	</package>
	<package>
		<id>2582016</id>
		<title>geometry_pack_5</title>
		<num_attempts>0</num_attempts>
		<scorm_grading_enabled>0</scorm_grading_enabled>
		<sco_grading_enabled>0</sco_grading_enabled>
		<grade_timing_type>0</grade_timing_type>
		<grade_timing_option>0</grade_timing_option>
		<url>http://schoology.com/course/625104/materials/package/2582016/launch</url>
		<available>1</available>
		<completed>0</completed>
		<completion_status />
		<count_in_grade>1</count_in_grade>
	</package>
	<total>2</total>
	<links>
		<self>http://schoology.com/v1/sections/625104/packages?start=0&amp;limit=20</self>
	</links>
</result>

GET sections/{section id}/package/{id}

View a specified scorm package

Return A scorm package

json
{
  "id": 2581911,
  "title": "statistics_pack_5",
  "num_attempts": 0,
  "scorm_grading_enabled": 0,
  "sco_grading_enabled": 1,
  "grade_timing_type": 0,
  "grade_timing_option": 0,
  "url": "http:\/\/schoology.com\/course\/625104\/materials\/package\/2581911\/launch",
  "available": 1,
  "completed": 0,
  "completion_status": "",
  "count_in_grade": 1
}
xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>2581911</id>
	<title>statistics_pack_5</title>
	<num_attempts>0</num_attempts>
	<scorm_grading_enabled>0</scorm_grading_enabled>
	<sco_grading_enabled>1</sco_grading_enabled>
	<grade_timing_type>0</grade_timing_type>
	<grade_timing_option>0</grade_timing_option>
	<url>http://schoology.com/course/625104/materials/package/2581911/launch</url>
	<available>1</available>
	<completed>0</completed>
	<completion_status />
	<count_in_grade>1</count_in_grade>
</result>

DELETE sections/{section id}/package/{id}

Delete a scorm package (cannot be undone)